/**
 * 
 */
package net.jbaez.code;

import java.lang.annotation.Annotation;

/*
 * Copyright 2008 DynamiCode
 * 
 * Licensed under the Apache License, Version 2.0 (the "License"); you may not
 * use this file except in compliance with the License. You may obtain a copy of
 * the License at
 * 
 * http://www.apache.org/licenses/LICENSE-2.0
 * 
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
 * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
 * License for the specific language governing permissions and limitations under
 * the License.
 */
/**
 * Interfaz comun a todos los elementos que aceptan anotacionesS
 */
public interface IAnnotatedElement {
    /**
     * Retorna el nombre del elemento
     * 
     * @return El nombre del elemento
     */
    public String getName();

    /**
     * Retorna las anotaciones presentes en el elemento
     * 
     * @return Un arreglo con las anotaciones que posee el elemento o
     *         <code>null</code> si no existen anotaciones
     */
    public JAnnotation[] getAnnotations();

    /**
     * Retorna la declaracion del tipo de anotacion solicitada
     * 
     * @param clazz
     *                La clase de la anotacion
     * @return La anotacion si esta presente o <code>null</code> si no existe
     *         la anotacion
     */
    public JAnnotation getAnnotation(Class<? extends Annotation> clazz);

    /**
     * Retorna una annotation si esta presente en el elemento anotado
     * 
     * @param type
     *                Tipo de de anotacion
     * @return Retorna la anotacion si esta presente o <code>null</code> si no
     *         esta presente
     */
    public JAnnotation getAnnotation(IType<? extends JAnnotation> type);

    /**
     * Retorna un valor que indica si la anotacion esta presente
     * 
     * @param clazz
     *                Tipo de la anotacion
     * @return <code>true</code> si existe o <code>false</code> si no
     */
    public boolean isAnnotationPresent(Class<? extends Annotation> clazz);

    /**
     * Verifica si existen una anotacion presente
     * 
     * @param type
     *                El tipo a buscar
     * @return <code>true</code> si existe la anotacion o <code>false</code>
     *         si no
     */
    public boolean isAnnotationPresent(IType<? extends JAnnotation> type);

}
